com.sun.n1.sps.model.executor
Interface TaskInfo

public interface TaskInfo

TaskInfo is the persistent version of Task descriptor. It contains:

• All of the settings used to run the plan
• The TaskID which uniquely identifies this Task
• TargetStatus information - which is a summary of the execution status and success of this Task for each of the targets

  Method Summary

  boolean	getAbortRequested() Returns true if this plan was asked to abort, false otherwise.
  TargetStatus[]	getAllTargetsStatus() Returns the target status objects for this task.
  java.lang.String	getDescription() Returns the description of this object.
  boolean	getDetailedPreflight() Returns whether to run the task with a detailed preflight.
  int	getNativeCallTimeoutSecs() Returns the timeout (in seconds) of each individual execNative call.
  ExecutionPlanID	getPlanID() Returns the ExecutionPlanID.
  int	getPlanThrottle() Returns the plan throttle.
  int	getPlanTimeoutSecs() Returns the timeout (in seconds) of the plan run.
  boolean	getPreflightFailed() Returns true if the plan failed in preflight, false otherwise.
  RunLevel	getRunLevel() Returns the run level at which the user requested the plan run.
  SubplanInfo[]	getSubplanInfos() Returns all of the subplaninfo objects, each of which contains the settings for an individual subplan.
  java.util.Date	getTaskComplete() Returns the date that this task completed.
  TaskID	getTaskID() Returns the TaskID which identifies this task.
  UserID	getTaskOwner() Returns the UserId on whose behalf this plan was run.
  java.util.Date	getTaskStart() Returns the start date for this task.
  TaskStatus	getTaskStatus() Returns the TaskStatus of the task.
  boolean	getTaskWasAborted() Returns whether this current task was requested to be aborted.

  Method Detail

  getTaskID

  TaskID getTaskID()

  Returns the TaskID which identifies this task.

  Returns:

  The TaskID which identifies this task.

  getTaskOwner

  UserID getTaskOwner()

  Returns the UserId on whose behalf this plan was run.

  Returns:

  The UserId on whose behalf this plan was run.

  getPlanTimeoutSecs

  int getPlanTimeoutSecs()

  Returns the timeout (in seconds) of the plan run.

  Returns:

  The timeout (in seconds) of the plan run.

  getNativeCallTimeoutSecs

  int getNativeCallTimeoutSecs()

  Returns the timeout (in seconds) of each individual execNative call.

  Returns:

  The timeout (in seconds) ofeach individual execNative call.

  getDetailedPreflight

  boolean getDetailedPreflight()

  Returns whether to run the task with a detailed preflight.

  Returns:

  Whether to run the task with a detailed preflight.

  getPlanThrottle

  int getPlanThrottle()

  Returns the plan throttle.

  Returns:

  The plan throttle.

  getPlanID

  ExecutionPlanID getPlanID()

  Returns the ExecutionPlanID.

  Returns:

  the ExecutionPlanID.

  getTaskStart

  java.util.Date getTaskStart()

  Returns the start date for this task.

  Returns:

  the start date or null.

  getTaskComplete

  java.util.Date getTaskComplete()

  Returns the date that this task completed.

  Returns:

  the date that this task completed.

  getTaskWasAborted

  boolean getTaskWasAborted()

  Returns whether this current task was requested to be aborted.

  Returns:

  Whether this current task was requested to be aborted.

  getSubplanInfos

  SubplanInfo[] getSubplanInfos()

  Returns all of the subplaninfo objects, each of which contains the settings for an individual subplan.

  Returns:

  An array of SubplanInfo[] values.

  getAllTargetsStatus

  TargetStatus[] getAllTargetsStatus()

  Returns the target status objects for this task.

  Returns:

  An array of TargetStatus objects which represents the status of every host on which this Task was run.

  getRunLevel

  RunLevel getRunLevel()

  Returns the run level at which the user requested the plan run.

  Returns:

  the run level at which the user requested the plan run.

  getPreflightFailed

  boolean getPreflightFailed()

  Returns true if the plan failed in preflight, false otherwise.

  Returns:

  true if the plan failed in preflight, false otherwise.

  getAbortRequested

  boolean getAbortRequested()

  Returns true if this plan was asked to abort, false otherwise.

  Returns:

  true if this plan was asked to abort, false otherwise.

  getTaskStatus

  TaskStatus getTaskStatus()

  Returns the TaskStatus of the task.

  Returns:

  The TaskStatus of the task.

  getDescription

  java.lang.String getDescription()

  Returns the description of this object.

  Returns:

  The description of this object.